home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 049a / compr220.zip / COMPRESS.DOC next >
Text File  |  1991-11-28  |  9KB  |  376 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                            Compress  v2.20
  7.  
  8.                     By Ed Crissey, FidoNet 1:268/69
  9.  
  10.  
  11.        (C) Copyright 1990 by Ed Crissey.  All Rights Reserved.
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                        November 28th, 1991
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66. -----------------------------------------------------------------------------
  67. Compress v2.20                                                         Page 2
  68.  
  69.  
  70.  
  71.                              INTRODUCTION
  72.  
  73.        Compress is a utility that will allow users of DataBridge,
  74.      QuickBBS, BinkleyTerm, FrontDoor, Remote Access, Dictator
  75.      Tick, Zmail, MsgRatio, or Qmail to compress the Log files.  This will
  76.      elimate the need to delete these files every few days after they
  77.      have grown to monstrous proportions.  There is a Config file you will
  78.      will need to create for compress.  The default name of the file is
  79.      'Compress.cfg' and it must be placed in the same directory as the
  80.      Compress pgm unless you use the '-C' Command Line Option.  The format
  81.      of the config file is as follows:
  82.  
  83. Line1:   SysOp Name            (  If your copy is not registered then leave )
  84. Line2:   System Name           (  these three lines blank.  Compress is     )
  85. Line3:   Registration Code     (  fully functional either way               )
  86. Lines 4 - Eof:  Here you specify the command line(s) parameters.
  87.                 One line is for one type of Log.  With a few examples as
  88.                 Follows:
  89.  
  90. -tqbbs -d3 -pc:\qbbs\system.log
  91. -tdb -d6 -pc:\db\dbridge.log -q
  92.  
  93. The config file command line paramters are explained as follows on the
  94. next page:
  95.  
  96.                    COMMAND LINE PARAMETERS
  97.  
  98. Compress
  99.  
  100. This invokes Compress and scans the current drive for 'Compress.cfg'
  101.  
  102. Compress -cc:\bbs\jungle.man
  103.  
  104. The invokes Compress and uses Config File 'Jungle.man' in Directory c:\bbs
  105.  
  106. '-C' is currently the only command line parameter available.  All others
  107. specified will be ignored.
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132. -----------------------------------------------------------------------------
  133. Compress v2.20                                                        Page 3
  134.  
  135.  
  136.                      CONFIG FILE COMMAND LINE OPTIONS
  137.  
  138.         [-t] [-d] [-p] [-q] [-logdiag]
  139.  
  140.         -T
  141.         ---------------------------------------------------------
  142.         The -T parameter is to tell compress what log file format
  143.         to compress and two valid options thus far are
  144.         -TDB  to compress the DataBridge Log Format.
  145.         -TQBBS to compress the QuickBBS Log Format.
  146.         -TBINK to compress the BinkleyTerm Log Format.
  147.         -TRAEXP to compress the RemoteAccess Expanded Log Format.
  148.         -TRA to compress the RemoteAccess Compressed Log Format.
  149.         -TFRONT to compress the FrontDoor Log Format. (Or Ra Compressed Format)
  150.         -TDICT to compress the Dictator Log Format.
  151.         -TTICK to compress the Tick Log Format.
  152.         -TZMAIL to compress the Zmail Log Format.
  153.         -TMSGRATIO to comrpess the MsgRatio Log Format.
  154.         -TQM to compress the Qmail Log Format.
  155.         -TMAX to compress the Maximus Log Format.
  156.         -TMSGTRACK to compress the Msgtrack Log Format.
  157.         -TXPRESS to compress the Xpress Log Format.
  158.         -TTM to compress the TeleMail Log Format.
  159.  
  160.  
  161.         -D
  162.         ---------------------------------------------------------
  163.         The -D parameter tells Compress how many days worth of log
  164.         data that you wish to retain.  The valid range is from
  165.         0 to 255.   Compress will scan the log file for the
  166.         datestamp on each record and determine what the X newest
  167.         days are whether they be consecutive or not and purge the
  168.         rest.
  169.  
  170.  
  171.         -P
  172.         --------------------------------------------------------
  173.         The -P option is used to tell Compress the full path as to
  174.         where the log file is.
  175.  
  176.         -Q
  177.         --------------------------------------------------------
  178.         The -Q option tells Compress to be quiet.
  179.  
  180.         -LOGDIAG
  181.         --------------------------------------------------------
  182.         The -LOGDIAG tells Compress to run in Diagnostic Mode.
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198. -----------------------------------------------------------------------------
  199. Compress v2.20                                                        Page 4
  200.  
  201.  
  202.   v1.01  -  To delete header title of QuickBBS log
  203.  
  204.   v1.02  -  Fix Bug in QuickBBS routine becuz of blank line after header
  205.  
  206.   v1.10  -  Added support for a online game called Dictator,BinklyTerm 2.40,
  207.             FrontDoor 1.99c, and Opus.  Since Remote Access uses the Opus or
  208.             FrontDoor Log style that will work as well.
  209.  
  210.   v1.11  -  Renamed the -TOPUS to -TRAOPUS since the routine works with the
  211.             Remote Access OPUS style log but not the OPUS log.  Do not use it
  212.             on an OPUS log.
  213.  
  214.   v1.20  -  Added support for Tick v2.00, Zmail v1.12, and MsgRatio v1.10
  215.  
  216.   v2.00  -  Performed a major rewrite of compress.  See Upgrade file for
  217.             details.  Added support for Qm and Maximus.  Added a Quiet Mode
  218.             Option also.  There is also a config file that needs to be created.
  219.  
  220.   v2.10  -  Added support for Msgtrack v3.10, Xpress v2.29, TeleMail v1.40.
  221.             Compress v2.10 was re-compiled with TP 6.0.
  222.  
  223.   v2.11  -  Increased the log record size from 80 bytes to 132 bytes.  This
  224.             should prevent information from being chopped out of the log.
  225.  
  226.   v2.20  -  Added Support for Remote Access v1.10 Expanded log format.  This
  227.             option is '-TRA' and you no longer need to run '-TFRONT' for the
  228.             Remote Access Expanded Log Format.  Renamed the '-TRAOPUS' to just
  229.             '-TRA' for the compressed format.  Also fixed a minor cosmetic
  230.             in the Qmail routine.
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264. -----------------------------------------------------------------------------
  265. Compress v2.20                                                        Page 5
  266.  
  267.  
  268.                  **  What is supported by Compress **
  269.  
  270.          1.  DataBridge        v1.30
  271.          2.  QuickBBS          v2.75
  272.          3.  Remote Access     v1.10
  273.          4.  BinkleyTerm       v2.50
  274.          5.  FrontDoor         v1.99c
  275.          6.  Dictator          v1.30
  276.          7.  Tick              v2.00
  277.          8.  Zmail             v1.25
  278.          9.  MsgRatio          v1.10
  279.         10.  Qmail             v1.00
  280.         11.  Maximus           v1.02
  281.         12.  MsgTrack          v3.10
  282.         13.  Silver Xpress     v2.29
  283.         14.  TeleMail          v1.40
  284.  
  285.  
  286.  
  287.   The above is what Compress has currently been tested with.  If you plan on
  288.   testing it with a new release or a product not mentioned above I suggest
  289.   making a backup of your log before trying Compress on it.  If you would like
  290.   to have another log format supported by Compress just sent me a copy of the
  291.   log and I'll get it into a future release.
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330. -----------------------------------------------------------------------------
  331. Compress v2.20                                                        Page 6
  332.  
  333.  
  334.  
  335.                        DOS ERRORLEVEL EXIT CODES
  336.  
  337.  
  338.      Compress will terminate with one of the following DOS errorlevels
  339.      set:
  340.  
  341.            0 .... Log File was successfully compressed.
  342.  
  343.            1 .... -T parameter not specified or is invalid.
  344.  
  345.            2 .... -D parameter not specified or is invalid.
  346.  
  347.            3 .... -P parameter not specified or is invalid.
  348.  
  349.            4 .... Log File was not found at specified path.
  350.  
  351.            5 .... I/O error on the Log File.
  352.  
  353.            6 .... Configuration File not found.
  354.  
  355.                                DISCLAIMER
  356.  
  357.  
  358.      This program is guaranteed to do absolutely nothing.  Use it at
  359.      your own risk.  No warranty is stated or implied.  The author shall
  360.      not be responsible for any damages resulting from it's use, directly
  361.      or indirectly.
  362.  
  363.      This software MUST be distributed free of charge.  UNDER ABSOLUTELY
  364.      NO CIRCUMSTANCES MAY IT BE SOLD!  It is copyrighted and is the sole
  365.      property of the author.  It may not be distributed in modified form.
  366.  
  367.      You may use the software only after agreeing upon the above terms.
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.                         ** End of Documentation **
  375.  
  376.